home *** CD-ROM | disk | FTP | other *** search
/ NetNews Offline 2 / NetNews Offline Volume 2.iso / news / comp / lang / c-part1 / 5122 < prev    next >
Encoding:
Internet Message Format  |  1996-08-05  |  1.7 KB
  1. Path: hermes.oc.com!usenet
  2. From: Larry Weiss <lfw@oc.com>
  3. Newsgroups: comp.lang.c
  4. Subject: Re: C Coding Standards
  5. Date: Fri, 09 Feb 1996 10:03:25 -0600
  6. Organization: OpenConnect Systems, Dallas, TX, USA
  7. Message-ID: <311B704D.39ED@oc.com>
  8. References: <4fd3r1$5ae@LNCSEX0003.eu.btco.com> <larry_kearney-0802961600170001@amaryllisp1.appsig.com>
  9. NNTP-Posting-Host: ocs2228.oc.com
  10. Mime-Version: 1.0
  11. Content-Type: text/plain; charset=us-ascii
  12. Content-Transfer-Encoding: 7bit
  13. X-Mailer: Mozilla 2.0 (Win16; I)
  14. CC: lfw@oc.com
  15.  
  16. > > Anyone know where I can get a start on writing some coding standards...
  17.  > > I would like to know what need s to be covered. Right now I can think of
  18.  > >
  19.  > > 1) Identifier naming conventions
  20.  > > 2) Headers - code layout- indentation etc
  21.  > >
  22.  > > Anyone know of an existing standard which one can adopt ?
  23.  
  24. Here are some topics that we cover in our coding standard at work:
  25.   o module headers (both .c and .h)
  26.   o function declaration header
  27.   o variable names (both global and local)
  28.   o statement typography
  29.   o statement indention
  30.   o expression typography
  31.   o comment (both block and statement level)
  32.   o function prototype policy
  33.   o "Hungarian notation" policy
  34.   o module names
  35.   o component architecture issues
  36.   o variable initialization policy
  37.   o portability issues (type names, memory management isolation, etc.)
  38.   o conditional compilation policy (#if, #ifdef usage)
  39.   o makefile issues (dependency usage, -D switch policy, etc)
  40.   o included file issues (multiple inclusion avoidance policies, etc)
  41.   o Standard C compliance policy
  42.   o max module length policy
  43.   o debugging instrumentation policies (permanence, format, etc)
  44.   o usage of TAB characters (allowed?, policy if allowed)
  45.